/*
 * Copyright 2017 ~ 2025 the original author or authors. James Wong <jameswong1376@gmail.com>>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.wl4g.infra.common.crypto.asymmetric;

import java.security.spec.KeySpec;

import com.wl4g.infra.common.codec.CodecSource;
import com.wl4g.infra.common.crypto.asymmetric.spec.KeyPairSpec;

/**
 * {@link AsymmetricCryptor}
 * 
 * @param <C>
 * @param <K>
 * @author James Wong &lt;jameswong1376@gmail.com&gt;
 * @version 2019年08月29日 v1.0.0
 * @see
 */
public interface AsymmetricCryptor {

    /**
     * Generate KeyPairSpec
     *
     * @return
     */
    KeyPairSpec generateKeyPair();

    /**
     * Generate KeyPairSpec.
     * 
     * @param publicKey
     * @param privateKey
     * @return
     */
    KeyPairSpec generateKeyPair(byte[] publicKey, byte[] privateKey);

    /**
     * Deserialization generate private KeySpec.
     * 
     * @param publicKey
     * @return
     */
    KeySpec generatePubKeySpec(byte[] publicKey);

    /**
     * Deserialization generate private KeySpec.
     * 
     * @param privateKey
     * @return
     */
    KeySpec generateKeySpec(byte[] privateKey);

    /**
     * Encrypt plain text based on the built key pair
     *
     * @param keySpec
     * @param plainSource
     * @return
     */
    CodecSource encrypt(final KeySpec keySpec, final CodecSource plainSource);

    /**
     * Decryption the hex ciphertext based on the constructed key pair
     *
     * @param keySpec
     * @param cipherSource
     * @return
     */
    CodecSource decrypt(final KeySpec keySpec, final CodecSource cipherSource);

    /**
     * Gets algorithm name
     *
     * @return
     */
    String getAlgorithmPrimary();

    /**
     * Gets algorithm paddings name
     *
     * @return
     */
    String getPadAlgorithm();

    /**
     * Gets asymmetric key digits
     *
     * @return
     */
    int getKeysize();

}